mediaplayer/io.github.kdroidfilter.composemediaplayer/[web]DefaultVideoPlayerState

DefaultVideoPlayerState

open class DefaultVideoPlayerState : VideoPlayerState

Implementation of VideoPlayerState for WebAssembly/JavaScript platform. Manages the state of a video player including playback controls, media information, and error handling.

Constructors

constructor()

Types

Companion

object Companion

Properties

applyPlaybackSpeedCallback

var applyPlaybackSpeedCallback: (Float) -> Unit?

Callback to apply playback speed changes to the underlying media player

applyVolumeCallback

var applyVolumeCallback: (Float) -> Unit?

Callback to apply volume changes to the underlying media player

aspectRatio

open override val aspectRatio: Float

availableSubtitleTracks

open override val availableSubtitleTracks: MutableList<SubtitleTrack>

currentSubtitleTrack

open override var currentSubtitleTrack: SubtitleTrack?

currentTime

open override val currentTime: Double

duration

open override val duration: Double

Returns the total duration of the media in seconds.

durationText

open override val durationText: String

Returns the total duration of the video as a formatted string.

error

open override val error: VideoPlayerError?

hasMedia

open override val hasMedia: Boolean

isFullscreen

open override var isFullscreen: Boolean

isLoading

open override val isLoading: Boolean

isPipActive

open var isPipActive: Boolean

isPipEnabled

open var isPipEnabled: Boolean

isPipSupported

open val isPipSupported: Boolean

isPlaying

open override val isPlaying: Boolean

Indicates whether the video is currently playing.

loop

open override var loop: Boolean

Specifies if the video should loop when it reaches the end.

metadata

open override val metadata: VideoMetadata

onPlaybackEnded

open override var onPlaybackEnded: () -> Unit?

Callback invoked when playback reaches the end of the media. Only called when loop is false. May be invoked from a background thread.

onRestart

open override var onRestart: () -> Unit?

Callback invoked when playback restarts from the beginning due to looping. Only called when loop is true. May be invoked from a background thread.

playbackSpeed

open override var playbackSpeed: Float

positionRecalculationCallback

var positionRecalculationCallback: () -> Unit?

Callback function to force recalculation of the HTML view position. This is set by the VideoPlayerSurface when the HTML view is created.

positionText

open override val positionText: String

Returns the current playback position as a formatted string.

sliderPos

open override var sliderPos: Float

Represents the current playback position as a value between 0.0 and 1000.0.

sourceUri

val sourceUri: String?

subtitleBackgroundColor

open override var subtitleBackgroundColor: Color

subtitlesEnabled

open override var subtitlesEnabled: Boolean

subtitleTextStyle

open override var subtitleTextStyle: TextStyle

userDragging

open override var userDragging: Boolean

Denotes whether the user is manually adjusting the playback position.

volume

open override var volume: Float

Controls the playback volume. Valid values are within the range of 0.0 (muted) to 1.0 (maximum volume).

Functions

clearCache

open fun clearCache()

Clears the shared video cache, removing all cached media data from disk.

clearError

open override fun clearError()

Clears any error state.

disableSubtitles

open override fun disableSubtitles()

Disables subtitles by clearing the current track and setting subtitlesEnabled to false.

dispose

open override fun dispose()

Disposes of resources used by the player.

enterPip

open suspend fun enterPip(): PipResult

forcePositionRecalculation

fun forcePositionRecalculation()

Forces recalculation of the HTML view position. This is useful when the layout changes and the HTML view needs to be repositioned.

onTimeUpdate

fun onTimeUpdate(currentTime: Float, duration: Float, forceUpdate: Boolean = false)

Callback for time update events from the media player.

openAsset

open fun openAsset(fileName: String, initializeplayerState: InitialPlayerState = InitialPlayerState.PLAY)

Opens a media file bundled with the application.

openFile

open override fun openFile(file: PlatformFile, initializeplayerState: InitialPlayerState = InitialPlayerState.PLAY)

Opens a media file.

openUri

open override fun openUri(uri: String, initializeplayerState: InitialPlayerState = InitialPlayerState.PLAY)

Opens a media source from the given URI.

pause

open override fun pause()

Pauses playback of the current media.

play

open override fun play()

Starts or resumes playback of the current media. If no media is loaded but a previous URI exists, reopens that media.

restart

open fun restart()

Restarts playback from the beginning. Works reliably from any state, including when playback has ended.

seekFinished

open fun seekFinished()

Commits the seek after a user-driven seek interaction. Performs the actual seek on the player and ends the dragging state.

seekStart

open fun seekStart(value: Float)

Begins a user-driven seek interaction (e.g. slider drag). Updates the visual slider position without performing the actual seek on the player. Must be followed by seekFinished to commit the seek.

seekTo